#region Copyright (c) 2006-2012 nHydrate.org, All Rights Reserved
// --------------------------------------------------------------------- *
//                           NHYDRATE.ORG                                *
//              Copyright (c) 2006-2012 All Rights reserved              *
//                                                                       *
//                                                                       *
// This file and its contents are protected by United States and         *
// International copyright laws.  Unauthorized reproduction and/or       *
// distribution of all or any portion of the code contained herein       *
// is strictly prohibited and will result in severe civil and criminal   *
// penalties.  Any violations of this copyright will be prosecuted       *
// to the fullest extent possible under law.                             *
//                                                                       *
// THE SOURCE CODE CONTAINED HEREIN AND IN RELATED FILES IS PROVIDED     *
// TO THE REGISTERED DEVELOPER FOR THE PURPOSES OF EDUCATION AND         *
// TROUBLESHOOTING. UNDER NO CIRCUMSTANCES MAY ANY PORTION OF THE SOURCE *
// CODE BE DISTRIBUTED, DISCLOSED OR OTHERWISE MADE AVAILABLE TO ANY     *
// THIRD PARTY WITHOUT THE EXPRESS WRITTEN CONSENT OF THE NHYDRATE GROUP *
//                                                                       *
// UNDER NO CIRCUMSTANCES MAY THE SOURCE CODE BE USED IN WHOLE OR IN     *
// PART, AS THE BASIS FOR CREATING A PRODUCT THAT PROVIDES THE SAME, OR  *
// SUBSTANTIALLY THE SAME, FUNCTIONALITY AS THIS PRODUCT                 *
//                                                                       *
// THE REGISTERED DEVELOPER ACKNOWLEDGES THAT THIS SOURCE CODE           *
// CONTAINS VALUABLE AND PROPRIETARY TRADE SECRETS OF NHYDRATE,          *
// THE REGISTERED DEVELOPER AGREES TO EXPEND EVERY EFFORT TO             *
// INSURE ITS CONFIDENTIALITY.                                           *
//                                                                       *
// THE END USER LICENSE AGREEMENT (EULA) ACCOMPANYING THE PRODUCT        *
// PERMITS THE REGISTERED DEVELOPER TO REDISTRIBUTE THE PRODUCT IN       *
// EXECUTABLE FORM ONLY IN SUPPORT OF APPLICATIONS WRITTEN USING         *
// THE PRODUCT.  IT DOES NOT PROVIDE ANY RIGHTS REGARDING THE            *
// SOURCE CODE CONTAINED HEREIN.                                         *
//                                                                       *
// THIS COPYRIGHT NOTICE MAY NOT BE REMOVED FROM THIS FILE.              *
// --------------------------------------------------------------------- *
#endregion
using System;

namespace nHydrate.EFCore.DataAccess
{
	/// <summary>
	/// This is the paging class to specify settings for paging operations
	/// </summary>
	[Serializable]
	public partial class Paging : nHydrate.EFCore.DataAccess.IPaging
	{
		#region Class Members

		private const int _def_pageIndex = 1;
		private const int _def_recordsperPage = 10;

		private int _pageIndex = _def_pageIndex;
		private int _recordsperPage = _def_recordsperPage;

		#endregion

		#region Constructors

		/// <summary>
		/// Creates a paging object
		/// </summary>
		public Paging()
			: this(_def_pageIndex, _def_recordsperPage)
		{
		}

		/// <summary>
		/// Creates a paging object
		/// </summary>
		/// <param name="pageIndex">The page index to load [1..N]</param>
		/// <param name="recordsperPage">The number of records per page.</param>
		public Paging(int pageIndex, int recordsperPage)
		{
			_pageIndex = pageIndex;
			_recordsperPage = recordsperPage;
		}

		#endregion

		#region Property Implementations

		/// <summary>
		/// The page number of load.
		/// </summary>
		public int PageIndex
		{
			get { return _pageIndex; }
			set
			{
				if (value < 1) throw new Exception("The PageIndex must be 1 or greater.");
				_pageIndex = value;
			}
		}

		/// <summary>
		/// The number of items per page.
		/// </summary>
		public int RecordsperPage
		{
			get { return _recordsperPage; }
			set
			{
				if (value < 1) throw new Exception("The RecordsperPage must be 1 or greater.");
				_recordsperPage = value;
			}
		}

		/// <summary>
		/// After the paged set is retrieved, this value is the total number of pages based on the filter
		/// </summary>
		public int PageCount { get; set; }

		/// <summary>
		/// The total number of non-paged items returned for the search.
		/// </summary>
		public int RecordCount { get; set; }

		#endregion

	}

}